home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / src / lib / c / string / mem.man < prev    next >
Text File  |  1989-02-09  |  2KB  |  69 lines
  1. ' Copyright 1989 Regents of the University of California
  2. ' Permission to use, copy, modify, and distribute this
  3. ' documentation for any purpose and without fee is hereby
  4. ' granted, provided that this notice appears in all copies.
  5. ' The University of California makes no representations about
  6. ' the suitability of this material for any purpose.  It is
  7. ' provided "as is" without express or implied warranty.
  8. ' 
  9. ' $Header: /sprite/src/lib/c/string/RCS/mem.man,v 1.2 89/02/09 10:27:17 ouster Exp $ SPRITE (Berkeley)
  10. ' 
  11. .so \*(]ltmac.sprite
  12. .HS mem lib
  13. .BS
  14. .SH NAME
  15. memchr, memcmp, memcpy, memset \- Operations on byte arrays
  16. .SH SYNOPSIS
  17. .nf
  18. \fB#include <string.h>
  19.  
  20. \fBchar *
  21. \fBmemchr(\fIs\fB, \fIc\fB, \fIn\fB)
  22.  
  23. \fBint
  24. \fBmemcmp(\fIs\fB, \fIs2\fB, \fIn\fB)
  25.  
  26. \fBchar *
  27. \fBmemcpy(\fIdest\fB, \fIsource\fB, \fIn\fB)
  28.  
  29. \fBchar *
  30. \fBmemset(\fIdest\fB, \fIc\fB, \fIn\fB)
  31. .SH ARGUMENTS
  32. .AS char source
  33. .AP char *s in
  34. Pointer to array of characters.
  35. .AP char *source in
  36. Pointer to array of characters to copy.
  37. .AP char *dest out
  38. Pointer to array of characters to modify.
  39. .AP int c in
  40. Value to search for (\fBmemchr\fR), or value to set to (\fBmemset\fR).
  41. .AP int n in
  42. Count of number of characters to test, copy, or set.
  43. .BE
  44.  
  45. .SH DESCRIPTION
  46. These procedures manipulate memory as counted arrays of bytes.
  47. .PP
  48. The \fBmemchr\fR procedure searches for the first occurrence of \fIc\fR
  49. in the \fIn\fR bytes starting at \fIs\fR, and returns the address of the
  50. first such occurrence.  If the value \fIc\fR is not found, then \fBNULL\fR
  51. is returned.
  52. .PP
  53. \fBMemcmp\fR compares two arrays of bytes, \fIs\fR and \fIs2\fR, in
  54. order, until a difference is found or \fIn\fR bytes have been compared.
  55. It returns a value greater than zero if, in the first differing byte,
  56. the value \fIs\fR is greater than the value in \fIs2\fR.  If the value
  57. in \fIs\fR is less than the value in \fIs2\fR, then a value less than
  58. zero is returned.  If the two arrays are identical in their first \fIn\fR
  59. bytes, then zero is returned.  Signed character comparison is used.
  60. .PP
  61. \fBMemcpy\fR copies \fIn\fR bytes from \fIsource\fR to \fIdest\fR and
  62. returns \fIdest\fR as its result.
  63. .PP
  64. \fBMemset\fR stores the value \fIc\fR in each of the \fIn\fR bytes starting
  65. at \fIdest\fR, and returns \fIdest\fR as its result.
  66.  
  67. .SH KEYWORDS
  68. characters, copy, memory, set, test
  69.